13.1 Listar Signatários de Aceite Digital
Request
Request
query DigitalAcceptanceSignatories {
digitalAcceptanceSignatories(
where: {
document: {
id: { eq: 1 }
}
}
) {
pageInfo {
hasNextPage
hasPreviousPage
}
items {
id
refId
fullName
email
cpf
type
phone
accessLink
status
acceptedAt
rejectedAt
rejectionReason
ipAddress
userAgent
geoLocation
documentHashAtAcceptance
notes
inviteSentAt
attemptCount
emailSendStatus
emailSendError
creationDate
active
document {
id
title
status
company {
id
name
}
}
}
totalCount
}
}
Params
Parâmetro | Tipo | Descrição |
---|---|---|
skip | Int | Número de registros a pular |
take | Int | Quantidade de registros |
where | DigitalAcceptanceSignatoryFilterInput | Filtros de busca |
order | [DigitalAcceptanceSignatorySortInput!] | Ordenação dos resultados |
Filtros Disponíveis
Objeto DigitalAcceptanceSignatoryFilterInput
Campo | Tipo | Descrição |
---|---|---|
and | [DigitalAcceptanceSignatoryFilterInput!] | Operador lógico AND |
or | [DigitalAcceptanceSignatoryFilterInput!] | Operador lógico OR |
id | IntOperationFilterInput | Filtro por ID |
refId | UuidOperationFilterInput | Filtro por RefID |
fullName | StringOperationFilterInput | Filtro por nome completo |
StringOperationFilterInput | Filtro por email | |
cpf | StringOperationFilterInput | Filtro por CPF |
type | SignatoryTypeOperationFilterInput | Filtro por tipo de signatário |
phone | StringOperationFilterInput | Filtro por telefone |
status | AcceptanceStatusOperationFilterInput | Filtro por status do aceite |
acceptedAt | DateTimeOperationFilterInput | Filtro por data de aceite |
rejectedAt | DateTimeOperationFilterInput | Filtro por data de rejeição |
rejectionReason | StringOperationFilterInput | Filtro por motivo de rejeição |
inviteSentAt | DateTimeOperationFilterInput | Filtro por data de envio |
attemptCount | IntOperationFilterInput | Filtro por tentativas de aceite |
emailSendStatus | EmailSendStatusOperationFilterInput | Filtro por status de envio email |
document | DigitalAcceptanceDocumentFilterInput | Filtro por documento |
creationDate | DateTimeOperationFilterInput | Filtro por data de criação |
active | BooleanOperationFilterInput | Filtro por status ativo |
Enum SignatoryType
Valor | Descrição |
---|---|
CONTRACTOR | Contratante |
CONTRACTED | Contratado |
WITNESS | Testemunha |
Enum AcceptanceStatus
Valor | Descrição |
---|---|
PENDING | Pendente |
ACCEPTED | Aceito |
REJECTED | Rejeitado |
EXPIRED | Expirado |
Enum EmailSendStatus
Valor | Descrição |
---|---|
UNDEFINED | Indefinido |
NOT_SENT | Não enviado |
SENT | Enviado |
Ordenação
Objeto DigitalAcceptanceSignatorySortInput
Campo | Tipo | Descrição |
---|---|---|
id | SortEnumType | Ordenar pela ID interna |
fullName | SortEnumType | Ordenar por nome completo |
SortEnumType | Ordenar por e-mail | |
cpf | SortEnumType | Ordenar por CPF |
type | SortEnumType | Ordenar por tipo |
status | SortEnumType | Ordenar por status do documento |
acceptedAt | SortEnumType | Ordenar por data de aceite |
rejectedAt | SortEnumType | Ordenar por data de rejeição |
inviteSentAt | SortEnumType | Ordenar por data de envio do convite |
attemptCount | SortEnumType | Ordenar por número de tentativas |
emailSendStatus | SortEnumType | Ordenar por status de envio de e-mail |
creationDate | SortEnumType | Ordenar por data de criação do registro |
Response
Campo | Tipo | Descrição |
---|---|---|
pageInfo | CollectionSegmentInfo! | Informações de paginação |
items | [DigitalAcceptanceSignatory!]! | Lista de signatários retornados na página atual |
totalCount | Int! | Total de registros disponíveis |
Objeto CollectionSegmentInfo
Contém metadados sobre a paginação da coleção.
Campo | Tipo | Descrição |
---|---|---|
hasNextPage | Boolean! | Indica se há uma próxima página de resultados |
hasPreviousPage | Boolean! | Indica se há uma página anterior de resultados |
Objeto DigitalAcceptanceSignatory
Detalhes completos de um signatário de um documento de aceite digital.
Campo | Tipo | Descrição |
---|---|---|
id | Int! | ID interno do signatário |
refId | UUID! | ID de referência (externo) |
fullName | String! | Nome completo do signatário |
String! | E-mail do signatário | |
cpf | String! | CPF do signatário |
type | SignatoryType! | Tipo de signatário (ex: Aluno, Responsável) |
phone | String | Telefone do signatário |
accessLink | String! | Link único de acesso para o aceite |
status | AcceptanceStatus! | Status atual do aceite (ex: Pendente, Aceito, Rejeitado) |
acceptedAt | DateTime | Data e hora do aceite |
rejectedAt | DateTime | Data e hora da rejeição |
rejectionReason | String | Motivo da rejeição (se aplicável) |
ipAddress | String | IP utilizado no aceite/rejeição |
userAgent | String | User-Agent (browser) utilizado no aceite/rejeição |
geoLocation | String | Localização geográfica registrada |
documentHashAtAcceptance | String | Hash do documento no momento do aceite para verificação |
notes | String | Observações |
inviteSentAt | DateTime | Data de envio do convite |
attemptCount | Int! | Número de tentativas de aceite |
emailSendStatus | EmailSendStatus! | Status do último envio de e-mail |
emailSendError | String | Mensagem de erro do envio de e-mail (se houver) |
creationDate | DateTime! | Data de criação do registro |
active | Boolean! | Status ativo |
document | DigitalAcceptanceDocument | Documento de aceite digital relacionado |
accessLinkUrl | String! | URL completa do link de acesso |
Objeto DigitalAcceptanceDocument
Detalhes do documento de aceite digital ao qual o signatário está vinculado.
Campo | Tipo | Descrição |
---|---|---|
id | Int! | ID interno do documento |
refId | UUID! | ID de referência (externo) |
title | String! | Título do documento |
status | DigitalAcceptanceStatus! | Status geral do documento (ex: Completo, Aberto) |
company | Company | Empresa relacionada ao documento |
Objeto Company
Informações básicas da empresa.
Campo | Tipo | Descrição |
---|---|---|
id | Int! | ID da empresa |
name | String! | Nome da empresa |